<HTML><HEAD>
<META NAME="copyright" CONTENT="Copyright (c) 1986-2008, Eiffel Software and others">
<META NAME="license" CONTENT="Eiffel Forum License v2 (see forum.txt)">
<META NAME="description" CONTENT="Access to command-line arguments. This class  may be used as ancestor by classes needing its facilities.">
<META NAME="library" CONTENT="Free implementation of ELKS library">
<META NAME="keywords" CONTENT="Eiffel class">
<META NAME="keywords" CONTENT="Eiffel class">
<TITLE>arguments Flat contracts</TITLE></HEAD>
<BODY BGCOLOR="white">
<P ALIGN="CENTER">Automatic generation produced by ISE Eiffel</P>
<PRE><TABLE BORDER="1" ALIGN="CENTER"><TR><TD><A HREF="../class_list.html">Classes</A></TD><TD><A HREF="../cluster_list.html">Clusters</A></TD><TD><A HREF="../cluster_hierarchy.html">Cluster hierarchy</A></TD><TD><A HREF="arguments_chart.html">Chart</A></TD><TD><A HREF="arguments_links.html">Relations</A></TD><TD>Flat contracts</TD></TR></TABLE><B>indexing</B>
    description: "[
        Access to command-line arguments. This class 
        may be used as ancestor by classes needing its facilities.
    ]"
    library: "Free implementation of ELKS library"
    copyright: "Copyright (c) 1986-2008, Eiffel Software and others"
    license: "Eiffel Forum License v2 (see forum.txt)"
    date: "$Date: 2008-05-24 02:24:07 +0200 (Sat, 24 May 2008) $"
    revision: "$Revision: 170 $"

<B>class</B> <B>interface</B>
    <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>


<B>create</B> 
    <A NAME="f_default_create"><A HREF="../base/any_flatshort.html#f_default_create">default_create</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Process instances of classes with no creation clause.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> (Default: do nothing.)</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
</A>
<B>feature</B> <FONT COLOR="red">--</FONT><FONT COLOR="red"> Access</FONT>

    <A NAME="f_argument"><A HREF="../base/arguments_flatshort.html#f_argument">argument</A> (i: <A HREF="../base/integer_32_flatshort.html">INTEGER_32</A>): <A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> </FONT>`i'<FONT COLOR="red">-th argument of command that started system execution</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> (the command name if </FONT>`i'<FONT COLOR="red"> = 0)</FONT>
        <B>require</B>
            index_large_enough: i &gt;= 0
            index_small_enough: i &lt;= <A HREF="../base/arguments_flatshort.html#f_argument_count">argument_count</A>
        <B>ensure</B>
            argument_not_void: <B>Result</B> /= <B>Void</B>
</A>
    <A NAME="f_argument_array"><A HREF="../base/arguments_flatshort.html#f_argument_array">argument_array</A>: <A HREF="../base/array_flatshort.html">ARRAY</A> [<A HREF="../base/string_8_flatshort.html">STRING_8</A>]
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Array containing command name (position 0) and arguments</FONT>
        <B>ensure</B>
            argument_array_not_void: <B>Result</B> /= <B>Void</B>
</A>
    <A NAME="f_command_line"><A HREF="../base/arguments_flatshort.html#f_command_line">command_line</A>: <A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Total command line</FONT>
        <B>ensure</B>
            <B>Result</B>.<A HREF="../base/readable_string_8_flatshort.html#f_count">count</A> &gt;= <A HREF="../base/arguments_flatshort.html#f_command_name">command_name</A>.<A HREF="../base/readable_string_8_flatshort.html#f_count">count</A>
</A>
    <A NAME="f_command_name"><A HREF="../base/arguments_flatshort.html#f_command_name">command_name</A>: <A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Name of command that started system execution</FONT>
        <B>ensure</B>
            definition: <B>Result</B>.<A HREF="../base/readable_string_8_flatshort.html#f_is_equal">is_equal</A> (<A HREF="../base/arguments_flatshort.html#f_argument">argument</A> (0))
</A>
    <A NAME="f_generating_type"><A HREF="../base/any_flatshort.html#f_generating_type">generating_type</A>: <A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Name of current object's generating type</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> (type of which it is a direct instance)</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            generating_type_not_void: <B>Result</B> /= <B>Void</B>
            generating_type_not_empty: <B>not</B> <B>Result</B>.<A HREF="../base/finite_flatshort.html#f_is_empty">is_empty</A>
</A>
    <A NAME="f_generator"><A HREF="../base/any_flatshort.html#f_generator">generator</A>: <A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Name of current object's generating class</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> (base class of the type of which it is a direct instance)</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            generator_not_void: <B>Result</B> /= <B>Void</B>
            generator_not_empty: <B>not</B> <B>Result</B>.<A HREF="../base/finite_flatshort.html#f_is_empty">is_empty</A>
</A>    
<B>feature</B> <FONT COLOR="red">--</FONT><FONT COLOR="red"> Measurement</FONT>

    <A NAME="f_argument_count"><A HREF="../base/arguments_flatshort.html#f_argument_count">argument_count</A>: <A HREF="../base/integer_32_flatshort.html">INTEGER_32</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Number of arguments given to command that started</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> system execution (command name does not count)</FONT>
        <B>ensure</B>
            argument_count_positive: <B>Result</B> &gt;= 0
</A>    
<B>feature</B> <FONT COLOR="red">--</FONT><FONT COLOR="red"> Comparison</FONT>

    <A NAME="f_deep_equal"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_deep_equal">deep_equal</A> (some: ?<A HREF="../base/any_flatshort.html">ANY</A>; other: <B>like</B> arg #1): <A HREF="../base/boolean_flatshort.html">BOOLEAN</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Are </FONT>`some'<FONT COLOR="red"> and </FONT>`other'<FONT COLOR="red"> either both void</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> or attached to isomorphic object structures?</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            shallow_implies_deep: <A HREF="../base/any_flatshort.html#f_standard_equal">standard_equal</A> (some, other) <B>implies</B> <B>Result</B>
            both_or_none_void: (some = <B>Void</B>) <B>implies</B> (<B>Result</B> = (other = <B>Void</B>))
            same_type: (<B>Result</B> <B>and</B> (some /= <B>Void</B>)) <B>implies</B> (other /= <B>Void</B> <B>and then</B> some.<A HREF="../base/any_flatshort.html#f_same_type">same_type</A> (other))
            symmetric: <B>Result</B> <B>implies</B> <A HREF="../base/any_flatshort.html#f_deep_equal">deep_equal</A> (other, some)
</A>
    <A NAME="f_equal"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_equal">equal</A> (some: ?<A HREF="../base/any_flatshort.html">ANY</A>; other: <B>like</B> arg #1): <A HREF="../base/boolean_flatshort.html">BOOLEAN</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Are </FONT>`some'<FONT COLOR="red"> and </FONT>`other'<FONT COLOR="red"> either both void or attached</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> to objects considered equal?</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            definition: <B>Result</B> = (some = <B>Void</B> <B>and</B> other = <B>Void</B>) <B>or else</B> ((some /= <B>Void</B> <B>and</B> other /= <B>Void</B>) <B>and then</B> some.<A HREF="../base/any_flatshort.html#f_is_equal">is_equal</A> (other))
</A>
    <A NAME="f_is_deep_equal"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_is_deep_equal">is_deep_equal</A> (other: <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>): <A HREF="../base/boolean_flatshort.html">BOOLEAN</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Are </FONT>`Current'<FONT COLOR="red"> and </FONT>`other'<FONT COLOR="red"> attached to isomorphic object structures?</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>require</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            other_not_void: other /= <B>Void</B>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            shallow_implies_deep: <A HREF="../base/any_flatshort.html#f_standard_is_equal">standard_is_equal</A> (other) <B>implies</B> <B>Result</B>
            same_type: <B>Result</B> <B>implies</B> <A HREF="../base/any_flatshort.html#f_same_type">same_type</A> (other)
            symmetric: <B>Result</B> <B>implies</B> other.<A HREF="../base/any_flatshort.html#f_is_deep_equal">is_deep_equal</A> (<B>Current</B>)
</A>
    <A NAME="f_is_equal"><A HREF="../base/any_flatshort.html#f_is_equal">is_equal</A> (other: <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>): <A HREF="../base/boolean_flatshort.html">BOOLEAN</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Is </FONT>`other'<FONT COLOR="red"> attached to an object considered</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> equal to current object?</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>require</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            other_not_void: other /= <B>Void</B>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            symmetric: <B>Result</B> <B>implies</B> other.<A HREF="../base/any_flatshort.html#f_is_equal">is_equal</A> (<B>Current</B>)
            consistent: <A HREF="../base/any_flatshort.html#f_standard_is_equal">standard_is_equal</A> (other) <B>implies</B> <B>Result</B>
</A>
    <A NAME="f_standard_equal"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_standard_equal">standard_equal</A> (some: ?<A HREF="../base/any_flatshort.html">ANY</A>; other: <B>like</B> arg #1): <A HREF="../base/boolean_flatshort.html">BOOLEAN</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Are </FONT>`some'<FONT COLOR="red"> and </FONT>`other'<FONT COLOR="red"> either both void or attached to</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> field-by-field identical objects of the same type?</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Always uses default object comparison criterion.</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            definition: <B>Result</B> = (some = <B>Void</B> <B>and</B> other = <B>Void</B>) <B>or else</B> ((some /= <B>Void</B> <B>and</B> other /= <B>Void</B>) <B>and then</B> some.<A HREF="../base/any_flatshort.html#f_standard_is_equal">standard_is_equal</A> (other))
</A>
    <A NAME="f_standard_is_equal"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_standard_is_equal">standard_is_equal</A> (other: <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>): <A HREF="../base/boolean_flatshort.html">BOOLEAN</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Is </FONT>`other'<FONT COLOR="red"> attached to an object of the same type</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> as current object, and field-by-field identical to it?</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>require</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            other_not_void: other /= <B>Void</B>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            same_type: <B>Result</B> <B>implies</B> <A HREF="../base/any_flatshort.html#f_same_type">same_type</A> (other)
            symmetric: <B>Result</B> <B>implies</B> other.<A HREF="../base/any_flatshort.html#f_standard_is_equal">standard_is_equal</A> (<B>Current</B>)
</A>    
<B>feature</B> <FONT COLOR="red">--</FONT><FONT COLOR="red"> Status report</FONT>

    <A NAME="f_coalesced_character_option_value"><A HREF="../base/arguments_flatshort.html#f_coalesced_character_option_value">coalesced_character_option_value</A> (o: <A HREF="../base/character_8_flatshort.html">CHARACTER_8</A>): ?<A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> The value, if any, specified for character option </FONT>`o'<FONT COLOR="red"> on</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> the command line.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Defined as follows (where 'X' is the current 'option_sign' and</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> 'xx' is an arbitrary, possibly empty sequence of characters):</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   </FONT>`val'<FONT COLOR="red"> if command line includes an argument of the form </FONT>`Xxxoval'
            <FONT COLOR="red">--</FONT><FONT COLOR="red">	   (this may be an empty string if argument is just </FONT>`Xxxo'<FONT COLOR="red">).</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   Void otherwise.</FONT>
        <B>require</B>
            o_non_null: o /= '%U'
</A>
    <A NAME="f_coalesced_word_option_value"><A HREF="../base/arguments_flatshort.html#f_coalesced_word_option_value">coalesced_word_option_value</A> (opt: <A HREF="../base/string_8_flatshort.html">STRING_8</A>): ?<A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> The value, if any, specified for word option </FONT>`opt'<FONT COLOR="red"> on the</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> command line.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Defined as follows (where X is the current </FONT><A HREF="../base/arguments_flatshort.html#f_option_sign">Option_sign</A><FONT COLOR="red">):</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   </FONT>`val'<FONT COLOR="red"> if command line includes an argument of the form </FONT>`Xoptval'
            <FONT COLOR="red">--</FONT><FONT COLOR="red">	   (this may be an empty string if argument is just </FONT>`Xopt'<FONT COLOR="red">).</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   Void otherwise.</FONT>
        <B>require</B>
            opt_non_void: opt /= <B>Void</B>
            opt_meaningful: <B>not</B> opt.<A HREF="../base/finite_flatshort.html#f_is_empty">is_empty</A>
</A>
    <A NAME="f_conforms_to"><A HREF="../base/any_flatshort.html#f_conforms_to">conforms_to</A> (other: <A HREF="../base/any_flatshort.html">ANY</A>): <A HREF="../base/boolean_flatshort.html">BOOLEAN</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Does type of current object conform to type</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> of </FONT>`other'<FONT COLOR="red"> (as per Eiffel: The Language, chapter 13)?</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>require</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            other_not_void: other /= <B>Void</B>
</A>
    <A NAME="f_index_of_beginning_with_word_option"><A HREF="../base/arguments_flatshort.html#f_index_of_beginning_with_word_option">index_of_beginning_with_word_option</A> (opt: <A HREF="../base/string_8_flatshort.html">STRING_8</A>): <A HREF="../base/integer_32_flatshort.html">INTEGER_32</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Does command line specify argument beginning with word</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> option </FONT>`opt'<FONT COLOR="red"> and, if so, at what position?</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> If one of the arguments in list of space-separated arguments</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> is </FONT>`Xoptxx'<FONT COLOR="red">, where </FONT>`X'<FONT COLOR="red"> is the current </FONT><A HREF="../base/arguments_flatshort.html#f_option_sign">Option_sign</A><FONT COLOR="red">, 'xx' </FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> is arbitrary, possibly empty sequence of characters,</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> then index of this argument in list;</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> else 0.</FONT>
        <B>require</B>
            opt_non_void: opt /= <B>Void</B>
            opt_meaningful: <B>not</B> opt.<A HREF="../base/finite_flatshort.html#f_is_empty">is_empty</A>
</A>
    <A NAME="f_index_of_character_option"><A HREF="../base/arguments_flatshort.html#f_index_of_character_option">index_of_character_option</A> (o: <A HREF="../base/character_8_flatshort.html">CHARACTER_8</A>): <A HREF="../base/integer_32_flatshort.html">INTEGER_32</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Does command line specify character option </FONT>`o'<FONT COLOR="red"> and, if so,</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> at what position?</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> If one of the space-separated arguments is of the form </FONT>`Xxxoyy'<FONT COLOR="red">,</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> where </FONT>`X'<FONT COLOR="red"> is the current </FONT><A HREF="../base/arguments_flatshort.html#f_option_sign">Option_sign</A><FONT COLOR="red">, </FONT>`xx'<FONT COLOR="red"> and </FONT>`yy'
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> are arbitrary, possibly empty sequences of characters,</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> then index of this argument in list of arguments;</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> else 0.</FONT>
        <B>require</B>
            o_non_null: o /= '%U'
</A>
    <A NAME="f_index_of_word_option"><A HREF="../base/arguments_flatshort.html#f_index_of_word_option">index_of_word_option</A> (opt: <A HREF="../base/string_8_flatshort.html">STRING_8</A>): <A HREF="../base/integer_32_flatshort.html">INTEGER_32</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Does command line specify word option </FONT>`opt'<FONT COLOR="red"> and, if so,</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> at what position?</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> If one of the arguments in list of space-separated arguments</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> is </FONT>`Xopt'<FONT COLOR="red">, where </FONT>`X'<FONT COLOR="red"> is the current </FONT><A HREF="../base/arguments_flatshort.html#f_option_sign">Option_sign</A><FONT COLOR="red">,</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> then index of this argument in list;</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> else 0.</FONT>
        <B>require</B>
            opt_non_void: opt /= <B>Void</B>
            opt_meaningful: <B>not</B> opt.<A HREF="../base/finite_flatshort.html#f_is_empty">is_empty</A>
</A>
    <A NAME="f_option_sign"><A HREF="../base/arguments_flatshort.html#f_option_sign">option_sign</A>: <A HREF="../base/character_8_ref_flatshort.html">CHARACTER_8_REF</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> The character used to signal options on the command line.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> This can be '%U' if no sign is necesary for the argument</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> to be an option</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Default is '-'</FONT>
</A>
    <A NAME="f_same_type"><A HREF="../base/any_flatshort.html#f_same_type">same_type</A> (other: <A HREF="../base/any_flatshort.html">ANY</A>): <A HREF="../base/boolean_flatshort.html">BOOLEAN</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Is type of current object identical to type of </FONT>`other'<FONT COLOR="red">?</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>require</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            other_not_void: other /= <B>Void</B>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            definition: <B>Result</B> = (<A HREF="../base/any_flatshort.html#f_conforms_to">conforms_to</A> (other) <B>and</B> other.<A HREF="../base/any_flatshort.html#f_conforms_to">conforms_to</A> (<B>Current</B>))
</A>
    <A NAME="f_separate_character_option_value"><A HREF="../base/arguments_flatshort.html#f_separate_character_option_value">separate_character_option_value</A> (o: <A HREF="../base/character_8_flatshort.html">CHARACTER_8</A>): ?<A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> The value, if any, specified after character option </FONT>`o'<FONT COLOR="red"> on</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> the command line.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> This is one of the following (where </FONT>`X'<FONT COLOR="red"> is the current</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> </FONT><A HREF="../base/arguments_flatshort.html#f_option_sign">Option_sign</A><FONT COLOR="red">, </FONT>`xx'<FONT COLOR="red"> and 'yy' are arbitrary, possibly empty</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> sequences of characters):</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   </FONT>`val'<FONT COLOR="red"> if command line includes two consecutive arguments</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">	   of the form </FONT>`Xxxoyy'<FONT COLOR="red"> and </FONT>`val'<FONT COLOR="red"> respectively.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   Empty string if command line includes argument </FONT>`Xxxoyy'<FONT COLOR="red">, which is</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">	   either last argument or followed by argument starting with </FONT>`X'<FONT COLOR="red">.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   Void if there is no argument of the form </FONT>`Xxxoyy'<FONT COLOR="red">.</FONT>
        <B>require</B>
            o_non_null: o /= '%U'
</A>
    <A NAME="f_separate_word_option_value"><A HREF="../base/arguments_flatshort.html#f_separate_word_option_value">separate_word_option_value</A> (opt: <A HREF="../base/string_8_flatshort.html">STRING_8</A>): ?<A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> The value, if any, specified after word option </FONT>`opt'<FONT COLOR="red"> on the</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> command line.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> This is one of the following (where </FONT>`X'<FONT COLOR="red"> is the current </FONT><A HREF="../base/arguments_flatshort.html#f_option_sign">Option_sign</A><FONT COLOR="red">):</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   </FONT>`val'<FONT COLOR="red"> if command line includes two consecutive arguments</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">	   of the form </FONT>`Xopt'<FONT COLOR="red"> and </FONT>`val'<FONT COLOR="red"> respectively.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   Empty string if command line includes argument </FONT>`Xopt'<FONT COLOR="red">, which is</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">	   either last argument or followed by argument starting with </FONT>`X'<FONT COLOR="red">.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">   Void if no </FONT>`Xopt'<FONT COLOR="red"> argument.</FONT>
        <B>require</B>
            opt_non_void: opt /= <B>Void</B>
            opt_meaningful: <B>not</B> opt.<A HREF="../base/finite_flatshort.html#f_is_empty">is_empty</A>
</A>    
<B>feature</B> <FONT COLOR="red">--</FONT><FONT COLOR="red"> Status setting</FONT>

    <A NAME="f_set_option_sign"><A HREF="../base/arguments_flatshort.html#f_set_option_sign">set_option_sign</A> (c: <A HREF="../base/character_8_flatshort.html">CHARACTER_8</A>)
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Make </FONT>`c'<FONT COLOR="red"> the option sign.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Use'%U' if no sign is necesary for the argument to</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> be an option</FONT>
</A>    
<B>feature</B> <FONT COLOR="red">--</FONT><FONT COLOR="red"> Duplication</FONT>

    <A NAME="f_copy"><A HREF="../base/any_flatshort.html#f_copy">copy</A> (other: <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>)
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Update current object using fields of object attached</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> to </FONT>`other'<FONT COLOR="red">, so as to yield equal objects.</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>require</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            other_not_void: other /= <B>Void</B>
            type_identity: <A HREF="../base/any_flatshort.html#f_same_type">same_type</A> (other)
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            is_equal: <A HREF="../base/any_flatshort.html#f_is_equal">is_equal</A> (other)
</A>
    <A NAME="f_deep_copy"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_deep_copy">deep_copy</A> (other: <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>)
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Effect equivalent to that of:</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red">		</FONT><A HREF="../base/any_flatshort.html#f_copy">copy</A><FONT COLOR="red"> (</FONT>`other'<FONT COLOR="red"> . </FONT><A HREF="../base/any_flatshort.html#f_deep_twin">deep_twin</A><FONT COLOR="red">)</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>require</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            other_not_void: other /= <B>Void</B>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            deep_equal: <A HREF="../base/any_flatshort.html#f_deep_equal">deep_equal</A> (<B>Current</B>, other)
</A>
    <A NAME="f_deep_twin"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_deep_twin">deep_twin</A>: <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> New object structure recursively duplicated from Current.</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            deep_twin_not_void: <B>Result</B> /= <B>Void</B>
            deep_equal: <A HREF="../base/any_flatshort.html#f_deep_equal">deep_equal</A> (<B>Current</B>, <B>Result</B>)
</A>
    <A NAME="f_standard_copy"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_standard_copy">standard_copy</A> (other: <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>)
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Copy every field of </FONT>`other'<FONT COLOR="red"> onto corresponding field</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> of current object.</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>require</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            other_not_void: other /= <B>Void</B>
            type_identity: <A HREF="../base/any_flatshort.html#f_same_type">same_type</A> (other)
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            is_standard_equal: <A HREF="../base/any_flatshort.html#f_standard_is_equal">standard_is_equal</A> (other)
</A>
    <A NAME="f_standard_twin"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_standard_twin">standard_twin</A>: <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> New object field-by-field identical to </FONT>`other'<FONT COLOR="red">.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Always uses default copying semantics.</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            standard_twin_not_void: <B>Result</B> /= <B>Void</B>
            equal: <A HREF="../base/any_flatshort.html#f_standard_equal">standard_equal</A> (<B>Result</B>, <B>Current</B>)
</A>
    <A NAME="f_twin"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_twin">twin</A>: <A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> New object equal to </FONT>`Current'
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> </FONT><A HREF="../base/any_flatshort.html#f_twin">twin</A><FONT COLOR="red"> calls </FONT><A HREF="../base/any_flatshort.html#f_copy">copy</A><FONT COLOR="red">; to change copying/twining semantics, redefine </FONT><A HREF="../base/any_flatshort.html#f_copy">copy</A><FONT COLOR="red">.</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            twin_not_void: <B>Result</B> /= <B>Void</B>
            is_equal: <B>Result</B>.<A HREF="../base/any_flatshort.html#f_is_equal">is_equal</A> (<B>Current</B>)
</A>    
<B>feature</B> <FONT COLOR="red">--</FONT><FONT COLOR="red"> Basic operations</FONT>

    <A NAME="f_default"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_default">default</A>: ?<A HREF="../base/arguments_flatshort.html">ARGUMENTS</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Default value of object's type</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
</A>
    <A NAME="f_default_pointer"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_default_pointer">default_pointer</A>: <A HREF="../base/pointer_flatshort.html">POINTER</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Default value of type </FONT>`POINTER'
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> (Avoid the need to write </FONT>`p'<FONT COLOR="red">.</FONT><A HREF="../base/any_flatshort.html#f_default">default</A><FONT COLOR="red"> for</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> some </FONT>`p'<FONT COLOR="red"> of type </FONT>`POINTER'<FONT COLOR="red">.)</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
</A>
    <A NAME="f_default_rescue"><A HREF="../base/any_flatshort.html#f_default_rescue">default_rescue</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Process exception for routines with no Rescue clause.</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> (Default: do nothing.)</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
</A>
    <A NAME="f_do_nothing"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_do_nothing">do_nothing</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Execute a null action.</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
</A>    
<B>feature</B> <FONT COLOR="red">--</FONT><FONT COLOR="red"> Output</FONT>

    <A NAME="f_io"><A HREF="../base/any_flatshort.html#f_io">io</A>: <A HREF="../base/std_files_flatshort.html">STD_FILES</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Handle to standard file setup</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            io_not_void: <B>Result</B> /= <B>Void</B>
</A>
    <A NAME="f_out"><A HREF="../base/any_flatshort.html#f_out">out</A>: <A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> New string containing terse printable representation</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> of current object</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            out_not_void: <B>Result</B> /= <B>Void</B>
</A>
    <A NAME="f_print"><A HREF="../base/any_flatshort.html#f_print">print</A> (some: ?<A HREF="../base/any_flatshort.html">ANY</A>)
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Write terse external representation of </FONT>`some'
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> on standard output.</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
</A>
    <A NAME="f_tagged_out"><B>frozen</B> <A HREF="../base/any_flatshort.html#f_tagged_out">tagged_out</A>: <A HREF="../base/string_8_flatshort.html">STRING_8</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> New string containing terse printable representation</FONT>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> of current object</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            tagged_out_not_void: <B>Result</B> /= <B>Void</B>
</A>    
<B>feature</B> <FONT COLOR="red">--</FONT><FONT COLOR="red"> Platform</FONT>

    <A NAME="f_operating_environment"><A HREF="../base/any_flatshort.html#f_operating_environment">operating_environment</A>: <A HREF="../base/operating_environment_flatshort.html">OPERATING_ENVIRONMENT</A>
            <FONT COLOR="red">--</FONT><FONT COLOR="red"> Objects available from the operating system</FONT>
            <FONT COLOR="red">--</FONT> <FONT COLOR="red">(from </FONT><A HREF="../base/any_flatshort.html">ANY</A><FONT COLOR="red">)</FONT>
        <B>ensure</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
            operating_environment_not_void: <B>Result</B> /= <B>Void</B>
</A>    
<B>invariant</B>
        <FONT COLOR="red">--</FONT> <FONT COLOR="red">from </FONT><A HREF="../base/any_flatshort.html">ANY</A>
    reflexive_equality: <A HREF="../base/any_flatshort.html#f_standard_is_equal">standard_is_equal</A> (<B>Current</B>)
    reflexive_conformance: <A HREF="../base/any_flatshort.html#f_conforms_to">conforms_to</A> (<B>Current</B>)

<B>end</B> <FONT COLOR="red">--</FONT> <FONT COLOR="red">class </FONT><A HREF="../base/arguments_flatshort.html">ARGUMENTS</A><TABLE BORDER="1" ALIGN="CENTER"><TR><TD><A HREF="../class_list.html">Classes</A></TD><TD><A HREF="../cluster_list.html">Clusters</A></TD><TD><A HREF="../cluster_hierarchy.html">Cluster hierarchy</A></TD><TD><A HREF="arguments_chart.html">Chart</A></TD><TD><A HREF="arguments_links.html">Relations</A></TD><TD>Flat contracts</TD></TR></TABLE></PRE>
<P ALIGN="CENTER"> &#045;&#045; Generated by ISE Eiffel &#045;&#045 </P>
<P ALIGN="CENTER">For more details: <A HREF="http://www.eiffel.com">www.eiffel.com</A></P>
</BODY>
</HTML>

